home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / include / gaim / connection.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-10-18  |  9.6 KB  |  333 lines
  1. /**
  2.  * @file connection.h Connection API
  3.  * @ingroup core
  4.  *
  5.  * gaim
  6.  *
  7.  * Gaim is the legal property of its developers, whose names are too numerous
  8.  * to list here.  Please refer to the COPYRIGHT file distributed with this
  9.  * source distribution.
  10.  *
  11.  * This program is free software; you can redistribute it and/or modify
  12.  * it under the terms of the GNU General Public License as published by
  13.  * the Free Software Foundation; either version 2 of the License, or
  14.  * (at your option) any later version.
  15.  *
  16.  * This program is distributed in the hope that it will be useful,
  17.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19.  * GNU General Public License for more details.
  20.  *
  21.  * You should have received a copy of the GNU General Public License
  22.  * along with this program; if not, write to the Free Software
  23.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24.  *
  25.  * @see @ref connection-signals
  26.  */
  27. #ifndef _GAIM_CONNECTION_H_
  28. #define _GAIM_CONNECTION_H_
  29.  
  30. #include <stdlib.h>
  31. #include <time.h>
  32.  
  33. typedef struct _GaimConnection GaimConnection;
  34.  
  35. /**
  36.  * Flags to change behavior of the client for a given connection.
  37.  */
  38. typedef enum
  39. {
  40.     GAIM_CONNECTION_HTML       = 0x0001, /**< Connection sends/receives in 'HTML'. */
  41.     GAIM_CONNECTION_NO_BGCOLOR = 0x0002, /**< Connection does not send/receive
  42.                                background colors.                  */
  43.     GAIM_CONNECTION_AUTO_RESP  = 0x0004,  /**< Send auto responses when away.       */
  44.     GAIM_CONNECTION_FORMATTING_WBFO = 0x0008, /**< The text buffer must be formatted as a whole */
  45.     GAIM_CONNECTION_NO_NEWLINES = 0x0010, /**< No new lines are allowed in outgoing messages */
  46.     GAIM_CONNECTION_NO_FONTSIZE = 0x0020, /**< Connection does not send/receive font sizes */
  47.     GAIM_CONNECTION_NO_URLDESC = 0x0040,  /**< Connection does not support descriptions with links */
  48.     GAIM_CONNECTION_NO_IMAGES = 0x0080,  /**< Connection does not support sending of images */
  49. } GaimConnectionFlags;
  50.  
  51. typedef enum
  52. {
  53.     GAIM_DISCONNECTED = 0, /**< Disconnected. */
  54.     GAIM_CONNECTED,        /**< Connected.    */
  55.     GAIM_CONNECTING        /**< Connecting.   */
  56.  
  57. } GaimConnectionState;
  58.  
  59. #include "account.h"
  60. #include "plugin.h"
  61.  
  62. typedef struct
  63. {
  64.     void (*connect_progress)(GaimConnection *gc, const char *text,
  65.                              size_t step, size_t step_count);
  66.     void (*connected)(GaimConnection *gc);
  67.     void (*disconnected)(GaimConnection *gc);
  68.     void (*notice)(GaimConnection *gc, const char *text);
  69.     void (*report_disconnect)(GaimConnection *gc, const char *text);
  70.  
  71. } GaimConnectionUiOps;
  72.  
  73. struct _GaimConnection
  74. {
  75.     GaimPlugin *prpl;            /**< The protocol plugin.               */
  76.     GaimConnectionFlags flags;   /**< Connection flags.                  */
  77.  
  78.     GaimConnectionState state;   /**< The connection state.              */
  79.  
  80.     GaimAccount *account;        /**< The account being connected to.    */
  81.     int inpa;                    /**< The input watcher.                 */
  82.  
  83.     GSList *buddy_chats;         /**< A list of active chats.            */
  84.     void *proto_data;            /**< Protocol-specific data.            */
  85.  
  86.     char *display_name;          /**< The name displayed.                */
  87.     guint keep_alive;            /**< Keep-alive.                        */
  88.  
  89.     guint idle_timer;            /**< The idle timer.                    */
  90.     time_t login_time;           /**< Time of login.                     */
  91.     time_t login_time_official;  /**< Official time of login.            */
  92.     time_t last_sent_time;       /**< The time something was last sent.  */
  93.     int is_idle;                 /**< Idle state of the connection.      */
  94.  
  95.     char *away;                  /**< The current away message, or NULL  */
  96.     char *away_state;            /**< The last away type.                */
  97.     gboolean is_auto_away;       /**< Whether or not it's auto-away.     */
  98.  
  99.     int evil;                    /**< Warning level for AIM (why is
  100.                                       this here?)                        */
  101.  
  102.     gboolean wants_to_die;         /**< Wants to Die state.  This is set
  103.                                       when the user chooses to sign off,
  104.                                       or when the protocol is
  105.                                       disconnected and should not be
  106.                                       automatically reconnected
  107.                                       (incorrect password, etc.)         */
  108.     guint disconnect_timeout;    /**< Timer used for nasty stack tricks  */
  109. };
  110.  
  111. #ifdef __cplusplus
  112. extern "C" {
  113. #endif
  114.  
  115. /**************************************************************************/
  116. /** @name Connection API                                                  */
  117. /**************************************************************************/
  118. /*@{*/
  119.  
  120. /**
  121.  * Creates a connection to the specified account.
  122.  *
  123.  * @param account The account the connection should be connecting to.
  124.  *
  125.  * @return The gaim connection.
  126.  */
  127. GaimConnection *gaim_connection_new(GaimAccount *account);
  128.  
  129. /**
  130.  * Destroys and closes a gaim connection.
  131.  *
  132.  * @param gc The gaim connection to destroy.
  133.  */
  134. void gaim_connection_destroy(GaimConnection *gc);
  135.  
  136. /**
  137.  * Signs a connection on.
  138.  *
  139.  * @param gc The connection to sign on.
  140.  *
  141.  * @see gaim_connection_disconnect()
  142.  */
  143. void gaim_connection_connect(GaimConnection *gc);
  144.  
  145. /**
  146.  * Registers a connection.
  147.  *
  148.  * @param gc The connection to register.
  149.  */
  150. void gaim_connection_register(GaimConnection *gc);
  151.  
  152. /**
  153.  * Signs a connection off.
  154.  *
  155.  * @param gc The connection to sign off.
  156.  *
  157.  * @see gaim_connection_connect()
  158.  */
  159. void gaim_connection_disconnect(GaimConnection *gc);
  160.  
  161. /**
  162.  * Sets the connection state.
  163.  *
  164.  * @param gc    The connection.
  165.  * @param state The connection state.
  166.  */
  167. void gaim_connection_set_state(GaimConnection *gc, GaimConnectionState state);
  168.  
  169. /**
  170.  * Sets the connection's account.
  171.  *
  172.  * @param gc      The connection.
  173.  * @param account The account.
  174.  */
  175. void gaim_connection_set_account(GaimConnection *gc, GaimAccount *account);
  176.  
  177. /**
  178.  * Sets the connection's displayed name.
  179.  *
  180.  * @param gc   The connection.
  181.  * @param name The displayed name.
  182.  */
  183. void gaim_connection_set_display_name(GaimConnection *gc, const char *name);
  184.  
  185. /**
  186.  * Returns the connection state.
  187.  *
  188.  * @param gc The connection.
  189.  *
  190.  * @return The connection state.
  191.  */
  192. GaimConnectionState gaim_connection_get_state(const GaimConnection *gc);
  193.  
  194. /**
  195.  * Returns TRUE if the account is connected, otherwise returns FALSE.
  196.  *
  197.  * @return TRUE if the account is connected, otherwise returns FALSE.
  198.  */
  199. #define GAIM_CONNECTION_IS_CONNECTED(gc) \
  200.     (gc->state == GAIM_CONNECTED)
  201.  
  202. /**
  203.  * Returns the connection's account.
  204.  *
  205.  * @param gc The connection.
  206.  *
  207.  * @return The connection's account.
  208.  */
  209. GaimAccount *gaim_connection_get_account(const GaimConnection *gc);
  210.  
  211. /**
  212.  * Returns the connection's displayed name.
  213.  *
  214.  * @param gc The connection.
  215.  *
  216.  * @return The connection's displayed name.
  217.  */
  218. const char *gaim_connection_get_display_name(const GaimConnection *gc);
  219.  
  220. /**
  221.  * Updates the connection progress.
  222.  *
  223.  * @param gc    The connection.
  224.  * @param text  Information on the current step.
  225.  * @param step  The current step.
  226.  * @param count The total number of steps.
  227.  */
  228. void gaim_connection_update_progress(GaimConnection *gc, const char *text,
  229.                                      size_t step, size_t count);
  230.  
  231. /**
  232.  * Displays a connection-specific notice.
  233.  *
  234.  * @param gc   The connection.
  235.  * @param text The notice text.
  236.  */
  237. void gaim_connection_notice(GaimConnection *gc, const char *text);
  238.  
  239. /**
  240.  * Closes a connection with an error.
  241.  *
  242.  * @param gc     The connection.
  243.  * @param reason The error text.
  244.  */
  245. void gaim_connection_error(GaimConnection *gc, const char *reason);
  246.  
  247. /*@}*/
  248.  
  249. /**************************************************************************/
  250. /** @name Connections API                                                 */
  251. /**************************************************************************/
  252. /*@{*/
  253.  
  254. /**
  255.  * Disconnects from all connections.
  256.  */
  257. void gaim_connections_disconnect_all(void);
  258.  
  259. /**
  260.  * Returns a list of all active connections.
  261.  *
  262.  * @return A list of all active connections.
  263.  */
  264. GList *gaim_connections_get_all(void);
  265.  
  266. /**
  267.  * Returns a list of all connections in the process of connecting.
  268.  *
  269.  * @return A list of connecting connections.
  270.  */
  271. GList *gaim_connections_get_connecting(void);
  272.  
  273. /**
  274.  * Checks if gc is still a valid pointer to a gc.
  275.  *
  276.  * @return @c TRUE if gc is valid.
  277.  */
  278. #define GAIM_CONNECTION_IS_VALID(gc) (g_list_find(gaim_connections_get_all(), (gc)) || g_list_find(gaim_connections_get_connecting(), (gc)))
  279.  
  280. /*@}*/
  281.  
  282. /**************************************************************************/
  283. /** @name UI Registration Functions                                       */
  284. /**************************************************************************/
  285. /*@{*/
  286.  
  287. /**
  288.  * Sets the UI operations structure to be used for connections.
  289.  *
  290.  * @param ops The UI operations structure.
  291.  */
  292. void gaim_connections_set_ui_ops(GaimConnectionUiOps *ops);
  293.  
  294. /**
  295.  * Returns the UI operations structure used for connections.
  296.  *
  297.  * @return The UI operations structure in use.
  298.  */
  299. GaimConnectionUiOps *gaim_connections_get_ui_ops(void);
  300.  
  301. /*@}*/
  302.  
  303. /**************************************************************************/
  304. /** @name Connections Subsystem                                           */
  305. /**************************************************************************/
  306. /*@{*/
  307.  
  308. /**
  309.  * Initializes the connections subsystem.
  310.  */
  311. void gaim_connections_init(void);
  312.  
  313. /**
  314.  * Uninitializes the connections subsystem.
  315.  */
  316. void gaim_connections_uninit(void);
  317.  
  318. /**
  319.  * Returns the handle to the connections subsystem.
  320.  *
  321.  * @return The connections subsystem handle.
  322.  */
  323. void *gaim_connections_get_handle(void);
  324.  
  325. /*@}*/
  326.  
  327.  
  328. #ifdef __cplusplus
  329. }
  330. #endif
  331.  
  332. #endif /* _GAIM_CONNECTION_H_ */
  333.